DescribeFileSystems

Description

call the DescribeFileSystems interface to query file system information.

Request Method

POST

Request Path

/apsara/route/NAS/DescribeFileSystems

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
VpcId	BODY	string	No	vpc-bp1sevsgtqvk5gxbl****	proprietary network ID. must select the same VPC network as the cloud server ECS to be mounted.
PageSize	BODY	integer	No	1	the number of file systems contained in each page during paging query. value range: 1~100 default value: 10
PageNumber	BODY	integer	No	1	the page number of the file system list. starting value (default):1
regionId	BODY	string	Yes	No sample value for this parameter.	region id
FileSystemType	BODY	string	No	standard	file system type. Value: standard: General NAS
FileSystemId	BODY	string	No	109c04****	file system ID.
version	BODY	string	No	2016-01-01	version of api

Return data

Name	Type	Sample value	Description
Description	string	This can be the description of the created file system.	description information of the file system.
PageSize	integer	1	the number of file systems contained in each page.
VswId	string	vsw-bp1omfzsszekkvaxn****	switch ID.
Size	long	107374182400	storage package capacity.
AccessGroupName	string	test-001	the name of the permission group used by the mount point.
SearchBase	string	dc=example	LDAP search starting point.
MountTarget		No sample value for this parameter.	No description for this parameter.
URI	string	ldap://ldap.example.example	LDAP service address.
MeteredSize	long	1611661312	file system usage. non-real-time usage, which is the maximum usage in the last hour, in Byte.
PageNumber	integer	1	the paging page number of the file system list.
NetworkType	string	vpc	network type. Includes: vpc: vpc classic: Classic Network
Packages	array of package	No sample value for this parameter.	storage package information collection.
FileSystem		No sample value for this parameter.	No description for this parameter.
Bandwidth	long	150	the bandwidth of the file system. unit: MB/s. General NAS does not have this field.
ExpiredTime	string	2020-01-05T16:00:00Z	storage package expiration time.
PackageType	string	hybrid	storage package type.
FileSystemId	string	109c04****	file system ID.
VolumeSize	long	1000	general NAS capacity. Includes: Capacity type: 0~10 PB Performance type: 0~1 PB
FileSystems	array of filesystem	No sample value for this parameter.	file system description information set.
Status	string	Pending	file system status. Extreme NAS returns this field, including: Pending: the file system is currently processing tasks. Running: the current file system is available, and subsequent operations (for example, creating mount points, etc.) can only be performed when the status is Running. Stopped: the current file system is not available. Extending: the file system is currently being expanded. Stopping: the current file system is down. Deleting: the current file system is being deleted.
Ldap	struct	No sample value for this parameter.	LDAP configuration. only the CPFS file system returns this parameter.
StorageType	string	Performance	storage type. Includes: general purpose NAS:Capacity (capacity type), Performance (performance type) Extreme NAS:standard (standard), advance (advanced)
RequestId	string	035B3A3A-E514-4B41-B906-5D906CFB****	request ID.
ZoneId	string	cn-hangzhou-b	the available area where the file system is located.
CreateTime	string	2017-05-27T15:43:06CST	file system creation time.
MeteredIASize	long	1000	low frequency media storage.
SupportedFeatures	list	Lifecycle	functions supported by the file system. Includes: Lifecycle: lifecycle management. Quota: quota management.
MountTargets	array of mounttarget	No sample value for this parameter.	mount point information set.
StartTime	string	2019-12-05T01:40:56Z	storage package start time.
QuotaSize	long	100	file system capacity.
TotalCount	integer	1	the total number of file systems.
EncryptType	integer	1	encryption type. Includes: 0: No encryption 1: Encryption
VpcId	string	vpc-bp1sevsgtqvk5gxbl****	proprietary network ID.
MountTargetDomain	string	109c042666-w****.cn-hangzhou.nas.aliyuncs.com	mount point domain name.
ChargeType	string	PayAsYouGo	billing type. Includes: Subscription: package year and month PayAsYouGo: Pay-as-you-go Package: bound storage package
ProtocolType	string	NFS	file system protocol type. Includes: NFS:NFS file protocol SMB:SMB file protocol
FileSystemType	string	all	file system type.
PackageId	string	naspackage-0be9c4b624-37****	storage package ID.
Package		No sample value for this parameter.	No description for this parameter.
RegionId	string	cn-hangzhou	region ID.
BindDN	string	cn=alibaba,dc=com	Bind the specified entry of LDAP.

Example

Successful Response example

{
 "Description":"This can be the description of the created file system.",
 "PageSize":"1",
 "VswId":"vsw-bp1omfzsszekkvaxn****",
 "Size":"107374182400",
 "AccessGroupName":"test-001",
 "SearchBase":"dc=example",
 "MountTarget":"",
 "URI":"ldap://ldap.example.example",
 "MeteredSize":"1611661312",
 "PageNumber":"1",
 "NetworkType":"vpc",
 "Packages":"",
 "FileSystem":"",
 "Bandwidth":"150",
 "ExpiredTime":"2020-01-05T16:00:00Z",
 "PackageType":"hybrid",
 "FileSystemId":"109c04****",
 "VolumeSize":"1000",
 "FileSystems":"",
 "Status":"Pending",
 "Ldap":"",
 "StorageType":"Performance",
 "RequestId":"035B3A3A-E514-4B41-B906-5D906CFB****",
 "ZoneId":"cn-hangzhou-b",
 "CreateTime":"2017-05-27T15:43:06CST",
 "MeteredIASize":"1000",
 "SupportedFeatures":"Lifecycle",
 "MountTargets":"",
 "StartTime":"2019-12-05T01:40:56Z",
 "QuotaSize":"100",
 "TotalCount":"1",
 "EncryptType":"1",
 "VpcId":"vpc-bp1sevsgtqvk5gxbl****",
 "MountTargetDomain":"109c042666-w****.cn-hangzhou.nas.aliyuncs.com",
 "ChargeType":"PayAsYouGo",
 "ProtocolType":"NFS",
 "FileSystemType":"all",
 "PackageId":"naspackage-0be9c4b624-37****",
 "Package":"",
 "RegionId":"cn-hangzhou",
 "BindDN":"cn=alibaba,
 dc=com"
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}